GET Notes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves notes for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
take |
Number of notes to retrieve. Default is all notes |
integer |
None. |
skip |
Number of notes to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the notes before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of notes.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Note |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "NoteId": "36dd3253-0d5a-4a7c-88b7-048788172999", "Asset": { "AssetId": "84cdf837-ef57-4867-94ce-f362dcaa3022", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "06ddb045-a561-419a-883d-0f0a33d220ea", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a5036424-b2ce-4818-9f07-43727e4f0558", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "2cfbc267-6f22-4522-bd58-c8cff10def02", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "MeasurementValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7d3ebc3b-71b7-4125-a87c-fe7437cb69f0", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "MeasurementValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ee90403c-f8ef-40b9-b196-42d056a3e39f", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "358bc943-5a71-4dd2-afbe-22b65b1ad284", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "5c7f759b-dd96-47ac-9bfe-11aef56bde7c", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-04T12:22:14.4398107-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "a486688b-12c3-4420-a28a-01305ef3b7ba", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "36dd3253-0d5a-4a7c-88b7-048788172999", "Asset": { "AssetId": "84cdf837-ef57-4867-94ce-f362dcaa3022", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "06ddb045-a561-419a-883d-0f0a33d220ea", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a5036424-b2ce-4818-9f07-43727e4f0558", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "2cfbc267-6f22-4522-bd58-c8cff10def02", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "MeasurementValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7d3ebc3b-71b7-4125-a87c-fe7437cb69f0", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "MeasurementValueNeededDate": "2024-05-04T12:22:14.4398107-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ee90403c-f8ef-40b9-b196-42d056a3e39f", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "358bc943-5a71-4dd2-afbe-22b65b1ad284", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "5c7f759b-dd96-47ac-9bfe-11aef56bde7c", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-04T12:22:14.4398107-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "a486688b-12c3-4420-a28a-01305ef3b7ba", "CreateDate": "2024-05-04T12:22:14.4398107-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-04T12:22:14.4398107-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }